GET Properties?assetId={assetId}&propertyTypeId={propertyTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves properties for the given parameters. This will only retrieve properties that have a value. All parameters are optional.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| assetId |
Id of the asset |
globally unique identifier |
None. |
| propertyTypeId |
Id of the property type |
globally unique identifier |
None. |
| take |
Number of properties to retrieve. Default is all properties |
integer |
None. |
| skip |
Number of properties to skip before retrieval |
integer |
Default value is 0 |
| sort |
List of sorting rules to describe how to sort the properties before retrieval |
Collection of Sort |
None. |
| Operator | string |
None. |
|
| Field | string |
None. |
|
| Value | string |
None. |
|
| Logic | string |
None. |
|
| Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of properties.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Collection of Property |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": [
{
"PropertyId": "7df303b2-f299-41b8-a5b6-672c875b5b78",
"Asset": {
"AssetId": "7c034289-a831-4c8b-8225-f9cc6899c70d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d5bea402-3246-449f-9640-496221343dbf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "db8c4fe7-14a4-497a-9433-910c47220c15",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0a5c8ebb-08a5-4b26-9711-3e2e7b0328fe",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-04-28T18:47:59.0662613-07:00",
"MeasurementValueNeededDate": "2024-04-28T18:47:59.0662613-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b654187c-90cb-4cd0-b4db-4f036723340c",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "dbe55471-2cdb-4cf3-8488-01749468545c",
"EffectiveDate": "2024-04-28T18:47:59.0662613-07:00",
"StateType": {
"StateTypeId": "57d4b151-9bc9-4444-bd94-11615e8aae57",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d5bea402-3246-449f-9640-496221343dbf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "db8c4fe7-14a4-497a-9433-910c47220c15",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "22508ab1-f025-4084-8baa-d1bdff6c3779",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4b527603-72a4-4102-9996-a81fa66b4fa9",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8047b31b-60bd-41b3-8163-1292cb26a024",
"EffectiveDate": "2024-04-28T18:47:59.0662613-07:00",
"StatusType": {
"StatusTypeId": "d904c977-e6b0-4094-bb66-44e43871a6f6",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d5bea402-3246-449f-9640-496221343dbf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "db8c4fe7-14a4-497a-9433-910c47220c15",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3d0b2259-2269-4368-807b-27bd67598bfd",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "eb984269-59dc-4db6-a731-ca67f2456e8e",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8676004b-a916-4e31-a988-be41c993fb55",
"EffectiveDate": "2024-04-28T18:47:59.0662613-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "de565848-6bdf-44cb-b886-26b9db422d06",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9e5fa58b-60f3-4e41-9d77-adfd9d934639",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ec1bc2e6-4a89-40bc-ae33-239ad770ef49",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-04-28T18:47:59.0662613-07:00",
"MeasurementValueNeededDate": "2024-04-28T18:47:59.0662613-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "39cbd2aa-59be-4bc5-9c23-477b92a4f723",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "173b42a0-eb48-4ffe-9744-4a8e182f0bc1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d5bea402-3246-449f-9640-496221343dbf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "db8c4fe7-14a4-497a-9433-910c47220c15",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "d56daeba-537f-48c2-b6e5-2eeeb6642a72",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "357c04ad-75fa-413d-8ff1-02a7bb168b21",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bcb1eb34-e1e0-481e-9cd4-a0d829b83a43",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"SourceSystemId": "sample string 4",
"CompanyId": "df93273c-636a-4bce-8984-0c58fc3f03cf",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "aae1be4b-1abc-48a0-8d61-82b6bc38316e",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 7"
},
{
"PropertyId": "7df303b2-f299-41b8-a5b6-672c875b5b78",
"Asset": {
"AssetId": "7c034289-a831-4c8b-8225-f9cc6899c70d",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d5bea402-3246-449f-9640-496221343dbf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "db8c4fe7-14a4-497a-9433-910c47220c15",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "0a5c8ebb-08a5-4b26-9711-3e2e7b0328fe",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2024-04-28T18:47:59.0662613-07:00",
"MeasurementValueNeededDate": "2024-04-28T18:47:59.0662613-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "b654187c-90cb-4cd0-b4db-4f036723340c",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"State": {
"StateId": "dbe55471-2cdb-4cf3-8488-01749468545c",
"EffectiveDate": "2024-04-28T18:47:59.0662613-07:00",
"StateType": {
"StateTypeId": "57d4b151-9bc9-4444-bd94-11615e8aae57",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d5bea402-3246-449f-9640-496221343dbf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "db8c4fe7-14a4-497a-9433-910c47220c15",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "22508ab1-f025-4084-8baa-d1bdff6c3779",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4b527603-72a4-4102-9996-a81fa66b4fa9",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 4"
},
"Status": {
"StatusId": "8047b31b-60bd-41b3-8163-1292cb26a024",
"EffectiveDate": "2024-04-28T18:47:59.0662613-07:00",
"StatusType": {
"StatusTypeId": "d904c977-e6b0-4094-bb66-44e43871a6f6",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d5bea402-3246-449f-9640-496221343dbf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "db8c4fe7-14a4-497a-9433-910c47220c15",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "3d0b2259-2269-4368-807b-27bd67598bfd",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "eb984269-59dc-4db6-a731-ca67f2456e8e",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8676004b-a916-4e31-a988-be41c993fb55",
"EffectiveDate": "2024-04-28T18:47:59.0662613-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "de565848-6bdf-44cb-b886-26b9db422d06",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9e5fa58b-60f3-4e41-9d77-adfd9d934639",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ec1bc2e6-4a89-40bc-ae33-239ad770ef49",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2024-04-28T18:47:59.0662613-07:00",
"MeasurementValueNeededDate": "2024-04-28T18:47:59.0662613-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "39cbd2aa-59be-4bc5-9c23-477b92a4f723",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 8"
},
"ValueText": "sample string 1",
"PropertyType": {
"PropertyTypeId": "173b42a0-eb48-4ffe-9744-4a8e182f0bc1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "d5bea402-3246-449f-9640-496221343dbf",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "db8c4fe7-14a4-497a-9433-910c47220c15",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 8"
},
"DataType": {
"DataTypeId": "d56daeba-537f-48c2-b6e5-2eeeb6642a72",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "357c04ad-75fa-413d-8ff1-02a7bb168b21",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "bcb1eb34-e1e0-481e-9cd4-a0d829b83a43",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 6"
},
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"SourceSystemId": "sample string 4",
"CompanyId": "df93273c-636a-4bce-8984-0c58fc3f03cf",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 7"
},
"IsValid": true,
"IsValidMessage": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "aae1be4b-1abc-48a0-8d61-82b6bc38316e",
"CreateDate": "2024-04-28T18:47:59.0662613-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-04-28T18:47:59.0662613-07:00",
"LastModifiedUser": "sample string 7"
}
],
"Total": 1,
"Message": "sample string 1"
}